<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkRadioAction</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="Actions.html" title="Action-based menus and toolbars">
<link rel="prev" href="GtkToggleAction.html" title="GtkToggleAction">
<link rel="next" href="GtkRecentAction.html" title="GtkRecentAction">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkToggleAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Actions.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
<td><a accesskey="n" href="GtkRecentAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkRadioAction.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkRadioAction.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkRadioAction.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GtkRadioAction.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GtkRadioAction.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GtkRadioAction.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkRadioAction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkRadioAction.top_of_page"></a>GtkRadioAction</span></h2>
<p>GtkRadioAction — An action of which only one in a group can be active</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkRadioAction.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="GtkRadioAction.html#GtkRadioAction-struct" title="struct GtkRadioAction">GtkRadioAction</a>;
<a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="returnvalue">GtkRadioAction</span></a> *    <a class="link" href="GtkRadioAction.html#gtk-radio-action-new" title="gtk_radio_action_new ()">gtk_radio_action_new</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="GtkRadioAction.html#gtk-radio-action-get-group" title="gtk_radio_action_get_group ()">gtk_radio_action_get_group</a>          (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkRadioAction.html#gtk-radio-action-set-group" title="gtk_radio_action_set_group ()">gtk_radio_action_set_group</a>          (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="GtkRadioAction.html#gtk-radio-action-get-current-value" title="gtk_radio_action_get_current_value ()">gtk_radio_action_get_current_value</a>  (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkRadioAction.html#gtk-radio-action-set-current-value" title="gtk_radio_action_set_current_value ()">gtk_radio_action_set_current_value</a>  (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> current_value</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkRadioAction.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="GtkAction.html" title="GtkAction">GtkAction</a>
         +----<a class="link" href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a>
               +----GtkRadioAction
</pre>
</div>
<div class="refsect1">
<a name="GtkRadioAction.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkRadioAction implements
 <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkRadioAction.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkRadioAction.html#GtkRadioAction--current-value" title='The "current-value" property'>current-value</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  "<a class="link" href="GtkRadioAction.html#GtkRadioAction--group" title='The "group" property'>group</a>"                    <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>*       : Write
  "<a class="link" href="GtkRadioAction.html#GtkRadioAction--value" title='The "value" property'>value</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GtkRadioAction.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GtkRadioAction.html#GtkRadioAction-changed" title='The "changed" signal'>changed</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GtkRadioAction.description"></a><h2>Description</h2>
<p>
A <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> is similar to <a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>. A number of radio
actions can be linked together so that only one may be active at any
one time.
</p>
</div>
<div class="refsect1">
<a name="GtkRadioAction.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkRadioAction-struct"></a><h3>struct GtkRadioAction</h3>
<pre class="programlisting">struct GtkRadioAction;</pre>
<p>
The <span class="structname">GtkRadioAction</span> struct contains
only private members and should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-radio-action-new"></a><h3>gtk_radio_action_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="returnvalue">GtkRadioAction</span></a> *    gtk_radio_action_new                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
<p>
Creates a new <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> object. To add the action to
a <a class="link" href="GtkActionGroup.html" title="GtkActionGroup"><span class="type">GtkActionGroup</span></a> and set the accelerator for the action,
call <a class="link" href="GtkActionGroup.html#gtk-action-group-add-action-with-accel" title="gtk_action_group_add_action_with_accel ()"><code class="function">gtk_action_group_add_action_with_accel()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>A unique name for the action</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>The label displayed in menu items and on buttons, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td>
<td>A tooltip for this action, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
<td>The stock icon to display in widgets representing this
action, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The value which <a class="link" href="GtkRadioAction.html#gtk-radio-action-get-current-value" title="gtk_radio_action_get_current_value ()"><code class="function">gtk_radio_action_get_current_value()</code></a> should
return if this action is selected.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-radio-action-get-group"></a><h3>gtk_radio_action_get_group ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            gtk_radio_action_get_group          (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>);</pre>
<p>
Returns the list representing the radio group for this object.
Note that the returned list is only valid until the next change
to the group. 
</p>
<p>
A common way to set up a group of radio group is the following:
</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GSList</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">group </span><span class="symbol">=</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="usertype">GtkRadioAction</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">action</span><span class="symbol">;</span>
<span class="normal"> </span>
<span class="keyword">while</span><span class="normal"> </span><span class="symbol">(</span><span class="comment">/* more actions to add */</span><span class="symbol">)</span>
<span class="normal">  </span><span class="cbracket">{</span>
<span class="normal">     action </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkRadioAction.html#gtk-radio-action-new">gtk_radio_action_new</a></span><span class="normal"> </span><span class="symbol">(...);</span>
<span class="normal">     </span>
<span class="normal">     </span><span class="function"><a href="GtkRadioAction.html#gtk-radio-action-set-group">gtk_radio_action_set_group</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">action</span><span class="symbol">,</span><span class="normal"> group</span><span class="symbol">);</span>
<span class="normal">     group </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkRadioAction.html#gtk-radio-action-get-group">gtk_radio_action_get_group</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">action</span><span class="symbol">);</span>
<span class="normal">  </span><span class="cbracket">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the list representing the radio group for this object. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkAction][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-radio-action-set-group"></a><h3>gtk_radio_action_set_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_radio_action_set_group          (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>);</pre>
<p>
Sets the radio group for the radio action object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>a list representing a radio group</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-radio-action-get-current-value"></a><h3>gtk_radio_action_get_current_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gtk_radio_action_get_current_value  (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>);</pre>
<p>
Obtains the value property of the currently active member of 
the group to which <em class="parameter"><code>action</code></em> belongs.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>a <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the currently active group member</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-radio-action-set-current-value"></a><h3>gtk_radio_action_set_current_value ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_radio_action_set_current_value  (<em class="parameter"><code><a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> current_value</code></em>);</pre>
<p>
Sets the currently active group member to the member with value
property <em class="parameter"><code>current_value</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>a <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>current_value</code></em> :</span></p></td>
<td>the new value</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
</div>
<div class="refsect1">
<a name="GtkRadioAction.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkRadioAction--current-value"></a><h3>The <code class="literal">"current-value"</code> property</h3>
<pre class="programlisting">  "current-value"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
<p>
The value property of the currently active member of the group to which
this action belongs.
</p>
<p>Default value: 0</p>
<p class="since">Since 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkRadioAction--group"></a><h3>The <code class="literal">"group"</code> property</h3>
<pre class="programlisting">  "group"                    <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>*       : Write</pre>
<p>
Sets a new group for a radio action.
</p>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkRadioAction--value"></a><h3>The <code class="literal">"value"</code> property</h3>
<pre class="programlisting">  "value"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
<p>
The value is an arbitrary integer which can be used as a
convenient way to determine which action in the group is
currently active in an ::activate or ::changed signal handler.
See <a class="link" href="GtkRadioAction.html#gtk-radio-action-get-current-value" title="gtk_radio_action_get_current_value ()"><code class="function">gtk_radio_action_get_current_value()</code></a> and <a class="link" href="GtkActionGroup.html#GtkRadioActionEntry" title="struct GtkRadioActionEntry"><span class="type">GtkRadioActionEntry</span></a>
for convenient ways to get and set this property.
</p>
<p>Default value: 0</p>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GtkRadioAction.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkRadioAction-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *action,
                                                        <a class="link" href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> *current,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-NO-RECURSE:CAPS"><code class="literal">No Recursion</code></a></pre>
<p>
The ::changed signal is emitted on every member of a radio group when the
active member is changed. The signal gets emitted after the ::activate signals
for the previous and current active members.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action on which the signal is emitted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>current</code></em> :</span></p></td>
<td>the member of <em class="parameter"><code>action</code></em>s group which has just been activated</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>